HAL I2S APIs listing for migration

This section provides a full listing of the HAL1 APIs for migration. It includes the various constants, enumerations, structures, functions, and macros.

HAL I2S constants

HAL1	series	HAL2	Refer to
HAL_I2S_ERROR_DMA	h5, c0, f4, g0, g4, h7	HAL_I2S_ERROR_DMA	Refer to
HAL_I2S_ERROR_FRE	h5, h7	HAL_I2S_ERROR_FRE	Refer to
HAL_I2S_ERROR_INVALID_CALLBACK	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_ERROR_NONE	h5, c0, f4, g0, g4	HAL_I2S_ERROR_NONE	Refer to
HAL_I2S_ERROR_NOT_SUPPORTED	h5, h7	Removed / New Usage changes	Refer to
HAL_I2S_ERROR_NO_OGT	h5, h7	Removed / New Usage changes	Refer to
HAL_I2S_ERROR_OVR	h5, c0, f4, g0, g4, h7	HAL_I2S_ERROR_OVR	Refer to
HAL_I2S_ERROR_PRESCALER	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_ERROR_TIMEOUT	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_ERROR_UDR	h5, c0, f4, g0, g4, h7	HAL_I2S_ERROR_UDR	Refer to
I2S_AUDIOFREQ_11K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_11_KHZ	Refer to
I2S_AUDIOFREQ_16K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_16_KHZ	Refer to
I2S_AUDIOFREQ_192K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_192_KHZ	Refer to
I2S_AUDIOFREQ_22K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_22_KHZ	Refer to
I2S_AUDIOFREQ_32K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_32_KHZ	Refer to
I2S_AUDIOFREQ_44K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_44_KHZ	Refer to
I2S_AUDIOFREQ_48K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_48_KHZ	Refer to
I2S_AUDIOFREQ_8K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_8_KHZ	Refer to
I2S_AUDIOFREQ_96K	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_96_KHZ	Refer to
I2S_AUDIOFREQ_DEFAULT	h5, c0, f4, g0, g4, h7	HAL_I2S_AUDIO_FREQ_DEFAULT	Refer to
I2S_CPOL_HIGH	h5, c0, f4, g0, g4, h7	HAL_I2S_CLOCK_POLARITY_HIGH	Refer to
I2S_CPOL_LOW	h5, c0, f4, g0, g4, h7	HAL_I2S_CLOCK_POLARITY_LOW	Refer to
I2S_DATAFORMAT_16B	h5, c0, f4, g0, g4, h7	HAL_I2S_DATA_FORMAT_16_BIT	Refer to
I2S_DATAFORMAT_16B_EXTENDED	h5, c0, f4, g0, g4, h7	HAL_I2S_DATA_FORMAT_16_BIT_EXTENDED	Refer to
I2S_DATAFORMAT_24B	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
I2S_DATAFORMAT_32B	h5, c0, f4, g0, g4, h7	HAL_I2S_DATA_FORMAT_32_BIT	Refer to
I2S_DATA_24BIT_ALIGNMENT_LEFT	h5, h7	Removed / New Usage changes	Refer to
I2S_DATA_24BIT_ALIGNMENT_RIGHT	h5, h7	Removed / New Usage changes	Refer to
I2S_FIRSTBIT_LSB	h5, h7	HAL_I2S_LSB_FIRST	Refer to
I2S_FIRSTBIT_MSB	h5, h7	HAL_I2S_MSB_FIRST	Refer to
I2S_FLAG_DXP	h5, h7	Removed / New Usage changes	Refer to
I2S_FLAG_FRE	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
I2S_FLAG_MASK	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
I2S_FLAG_OVR	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
I2S_FLAG_RXP	h5, h7	Removed / New Usage changes	Refer to
I2S_FLAG_TXP	h5, h7	Removed / New Usage changes	Refer to
I2S_FLAG_UDR	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
I2S_IT_DXP	h5, h7	Removed / New Usage changes	Refer to
I2S_IT_ERR	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
I2S_IT_FRE	h5, h7	Removed / New Usage changes	Refer to
I2S_IT_OVR	h5, h7	Removed / New Usage changes	Refer to
I2S_IT_RXP	h5, h7	Removed / New Usage changes	Refer to
I2S_IT_TXP	h5, h7	Removed / New Usage changes	Refer to
I2S_IT_UDR	h5, h7	Removed / New Usage changes	Refer to
I2S_MASTER_KEEP_IO_STATE_DISABLE	h5, h7	Removed / New Usage changes	Refer to
I2S_MASTER_KEEP_IO_STATE_ENABLE	h5, h7	Removed / New Usage changes	Refer to
I2S_MCLKOUTPUT_DISABLE	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
I2S_MCLKOUTPUT_ENABLE	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
I2S_MODE_MASTER_FULLDUPLEX	h5, h7	HAL_I2S_MODE_MASTER_FULL_DUPLEX	Refer to
I2S_MODE_MASTER_RX	h5, c0, f4, g0, g4, h7	HAL_I2S_MODE_MASTER_RX	Refer to
I2S_MODE_MASTER_TX	h5, c0, f4, g0, g4, h7	HAL_I2S_MODE_MASTER_TX	Refer to
I2S_MODE_SLAVE_FULLDUPLEX	h5, h7	HAL_I2S_MODE_SLAVE_FULL_DUPLEX	Refer to
I2S_MODE_SLAVE_RX	h5, c0, f4, g0, g4, h7	HAL_I2S_MODE_SLAVE_RX	Refer to
I2S_MODE_SLAVE_TX	h5, c0, f4, g0, g4, h7	HAL_I2S_MODE_SLAVE_TX	Refer to
I2S_STANDARD_LSB	h5, c0, f4, g0, g4, h7	HAL_I2S_STANDARD_LSB	Refer to
I2S_STANDARD_MSB	h5, c0, f4, g0, g4, h7	HAL_I2S_STANDARD_MSB	Refer to
I2S_STANDARD_PCM_LONG	h5, c0, f4, g0, g4, h7	HAL_I2S_STANDARD_PCM_LONG	Refer to
I2S_STANDARD_PCM_SHORT	h5, c0, f4, g0, g4, h7	HAL_I2S_STANDARD_PCM_SHORT	Refer to
I2S_STANDARD_PHILIPS	h5, c0, f4, g0, g4, h7	HAL_I2S_STANDARD_PHILIPS	Refer to
I2S_WS_INVERSION_DISABLE	h5, h7	Removed / New Usage changes	Refer to
I2S_WS_INVERSION_ENABLE	h5, h7	Removed / New Usage changes	Refer to
HAL_I2S_ERROR_BUSY_LINE_RX	c0, f4, g0, g4	Removed / New Usage changes	Refer to
I2S_FLAG_BSY	c0, f4, g0, g4	Removed / New Usage changes	Refer to
I2S_FLAG_CHSIDE	c0, f4, g0, g4	Removed / New Usage changes	Refer to
I2S_FLAG_RXNE	c0, f4, g0, g4	Removed / New Usage changes	Refer to
I2S_FLAG_TXE	c0, f4, g0, g4	Removed / New Usage changes	Refer to
I2S_IT_RXNE	c0, f4, g0, g4	Removed / New Usage changes	Refer to
I2S_IT_TXE	c0, f4, g0, g4	Removed / New Usage changes	Refer to
I2S_CLOCK_EXTERNAL	f4	Not implemented yet in HAL2.	Refer to
I2S_CLOCK_PLL	f4	Not implemented yet in HAL2.	Refer to
I2S_CLOCK_PLLR	f4	Not implemented yet in HAL2.	Refer to
I2S_CLOCK_PLLSRC	f4	Not implemented yet in HAL2.	Refer to
I2S_FULLDUPLEXMODE_DISABLE	f4	Not implemented yet in HAL2.	Refer to
I2S_FULLDUPLEXMODE_ENABLE	f4	Not implemented yet in HAL2.	Refer to
HAL_I2S_ERROR_CB_ID	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_MSPDEINIT_CB_ID	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_MSPINIT_CB_ID	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_RX_COMPLETE_CB_ID	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_RX_HALF_COMPLETE_CB_ID	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_STATE_BUSY	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_STATE_BUSY_RX	h5, c0, f4, g0, g4, h7	HAL_I2S_STATE_RX_ACTIVE	Refer to
HAL_I2S_STATE_BUSY_TX	h5, c0, f4, g0, g4, h7	HAL_I2S_STATE_TX_ACTIVE	Refer to
HAL_I2S_STATE_BUSY_TX_RX	h5, f4, h7	HAL_I2S_STATE_TX_RX_ACTIVE	Refer to
HAL_I2S_STATE_ERROR	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_STATE_READY	h5, c0, f4, g0, g4, h7	HAL_I2S_STATE_INIT	Refer to
HAL_I2S_STATE_RESET	h5, c0, f4, g0, g4, h7	HAL_I2S_STATE_RESET	Refer to
HAL_I2S_STATE_TIMEOUT	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_TX_COMPLETE_CB_ID	h5, c0, f4, g0, g4, h7	TRemoved / New Usage changes	Refer to
HAL_I2S_TX_HALF_COMPLETE_CB_ID	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_TX_RX_COMPLETE_CB_ID	h5, f4, h7	Removed / New Usage changes	Refer to
HAL_I2S_TX_RX_HALF_COMPLETE_CB_ID	h5, f4, h7	Removed / New Usage changes	Refer to

---

HAL I2S enumerations

HAL1	series	HAL2	Refer to
HAL_I2S_CallbackIDTypeDef	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_StateTypeDef	h5, c0, f4, g0, g4, h7	hal_i2s_state_t	Refer to

---

HAL I2S macros

HAL1	series	HAL2	Refer to
I2SxEXT	f4	Not implemented yet in HAL2.	Refer to
__HAL_I2SEXT_CLEAR_OVRFLAG	f4	Removed / New Usage changes	Refer to
__HAL_I2SEXT_CLEAR_UDRFLAG	f4	Removed / New Usage changes	Refer to
__HAL_I2SEXT_DISABLE	f4	Removed / New Usage changes	Refer to
__HAL_I2SEXT_DISABLE_IT	f4	Removed / New Usage changes	Refer to
__HAL_I2SEXT_ENABLE	f4	Removed / New Usage changes	Refer to
__HAL_I2SEXT_ENABLE_IT	f4	Removed / New Usage changes	Refer to
__HAL_I2SEXT_FLUSH_RX_DR	f4	Not implemented yet in HAL2.	Refer to
__HAL_I2SEXT_GET_FLAG	f4	Removed / New Usage changes	Refer to
__HAL_I2SEXT_GET_IT_SOURCE	f4	Removed / New Usage changes	Refer to
__HAL_I2S_CLEAR_OVRFLAG	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
__HAL_I2S_CLEAR_TIFREFLAG	h5, h7	Removed / New Usage changes	Refer to
__HAL_I2S_CLEAR_UDRFLAG	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
__HAL_I2S_DISABLE	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
__HAL_I2S_DISABLE_IT	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
__HAL_I2S_ENABLE	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
__HAL_I2S_ENABLE_IT	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
__HAL_I2S_FLUSH_RX_DR	c0, f4, g0, g4	Not implemented yet in HAL2.	Refer to
__HAL_I2S_GET_FLAG	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
__HAL_I2S_GET_IT_SOURCE	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
__HAL_I2S_RESET_HANDLE_STATE	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to

---

HAL I2S structures

HAL1	series	HAL2	Refer to
I2S_HandleTypeDef	h5, c0, f4, g0, g4, h7	hal_i2s_handle_t	Refer to
I2S_InitTypeDef	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
pI2S_CallbackTypeDef	h5, c0, f4, g0, g4, h7, l4	hal_i2s_cb_t	Refer to

---

HAL I2S functions

HAL1	series	HAL2	Refer to
HAL_I2SEx_TransmitReceive	h5, f4, h7	HAL_I2S_TransmitReceive	Refer to
HAL_I2SEx_TransmitReceive_DMA	h5, f4, h7	HAL_I2S_TransmitReceive_DMA	Refer to
HAL_I2SEx_TransmitReceive_IT	h5, f4, h7	HAL_I2S_TransmitReceive_IT	Refer to
HAL_I2SEx_TxRxCpltCallback	h5, f4, h7	HAL_I2S_TxRxCpltCallback	Refer to
HAL_I2SEx_TxRxHalfCpltCallback	h5, f4, h7	HAL_I2S_TxRxHalfCpltCallback	Refer to
HAL_I2S_DMAPause	h5, c0, f4, g0, g4, h7	HAL_I2S_MASTER_Pause	Refer to
HAL_I2S_DMAResume	h5, c0, f4, g0, g4, h7	HAL_I2S_MASTER_Resume	Refer to
HAL_I2S_DMAStop	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_DeInit	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_DisableIOSwap	h5, h7	HAL_I2S_DisableIOSwap	Refer to
HAL_I2S_EnableIOSwap	h5, h7	HAL_I2S_EnableIOSwap	Refer to
HAL_I2S_ErrorCallback	h5, c0, f4, g0, g4, h7	HAL_I2S_ErrorCallback	Refer to
HAL_I2S_GetError	h5, c0, f4, g0, g4, h7	HAL_I2S_GetLastErrorCodes	Refer to
HAL_I2S_GetState	h5, c0, f4, g0, g4, h7	HAL_I2S_GetState	Refer to
HAL_I2S_IRQHandler	h5, c0, f4, g0, g4, h7	HAL_I2S_IRQHandler	Refer to
HAL_I2S_Init	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_IsEnabledIOSwap	h5, h7	HAL_I2S_IsEnabledIOSwap	Refer to
HAL_I2S_MspDeInit	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_MspInit	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_Receive	h5, c0, f4, g0, g4, h7	HAL_I2S_Receive	Refer to
HAL_I2S_Receive_DMA	h5, c0, f4, g0, g4, h7	HAL_I2S_Receive_DMA	Refer to
HAL_I2S_Receive_IT	h5, c0, f4, g0, g4, h7	HAL_I2S_Receive_IT	Refer to
HAL_I2S_RegisterCallback	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2S_RxCpltCallback	h5, c0, f4, g0, g4, h7	HAL_I2S_RxCpltCallback	Refer to
HAL_I2S_RxHalfCpltCallback	h5, c0, f4, g0, g4, h7	HAL_I2S_RxHalfCpltCallback	Refer to
HAL_I2S_Transmit	h5, c0, f4, g0, g4, h7	HAL_I2S_Transmit	Refer to
HAL_I2S_Transmit_DMA	h5, c0, f4, g0, g4, h7	HAL_I2S_Transmit_DMA	Refer to
HAL_I2S_Transmit_IT	h5, c0, f4, g0, g4, h7	HAL_I2S_Transmit_IT	Refer to
HAL_I2S_TxCpltCallback	h5, c0, f4, g0, g4, h7	HAL_I2S_TxCpltCallback	Refer to
HAL_I2S_TxHalfCpltCallback	h5, c0, f4, g0, g4, h7	HAL_I2S_TxHalfCpltCallback	Refer to
HAL_I2S_UnRegisterCallback	h5, c0, f4, g0, g4, h7	Removed / New Usage changes	Refer to
HAL_I2SEx_FullDuplex_IRQHandler	f4	Not implemented yet in HAL2.	Refer to

---

HAL I2S legacy aliases (HAL1 to HAL1)

Note

This table provides a list of HAL1 to HAL1 legacy aliases defined in the stm32_hal_legacy.h HAL1 header file. To migrate the aliased HAL1 APIs, search for them in the HAL1 to HAL2 sections: HAL I2S constants, HAL I2S enumerations, HAL I2S macros, HAL I2S structures, HAL I2S functions.

HAL1 legacy API alias	HAL1 API
I2S_FLAG_RXNE	I2S_FLAG_RXP
I2S_FLAG_TXE	I2S_FLAG_TXP
I2S_STANDARD_PHILLIPS	I2S_STANDARD_PHILIPS
I2S_IT_RXNE	I2S_IT_RXP
I2S_IT_TXE	I2S_IT_TXP
I2S_CLOCK_SYSCLK	I2S_CLOCK_PLL
__HAL_I2S_CLEAR_FREFLAG	__HAL_I2S_CLEAR_TIFREFLAG